Contribution org.nuxeo.ecm.platform.forms.layout.MainContribution--widgets
In component org.nuxeo.ecm.platform.forms.layout.MainContribution
This contribution is part of XML component org.nuxeo.ecm.platform.forms.layout.MainContribution
inside nuxeo-platform-forms-layout-client-5.8.jar
Extension Point
Extension point widgets of component LayoutStore.Contributed Items
XML Source
<extension point="widgets" target="org.nuxeo.ecm.platform.forms.layout.LayoutStore">
<widget name="escape" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Escape</label>
</labels>
<helpLabels>
<label mode="any">
If set to false, the held value will not be escaped.
For instance if it contains HTML tags, they will be
rendered as part of
the rendered HTML page instead of being rendered as text content.
Defaults to true.
</label>
</helpLabels>
<fields>
<field>escape</field>
</fields>
</widget>
<widget name="style" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Style</label>
</labels>
<fields>
<field>style</field>
</fields>
</widget>
<widget name="styleClass" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Style class</label>
</labels>
<fields>
<field>styleClass</field>
</fields>
</widget>
<widget name="subStyleClass" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Sub style class</label>
</labels>
<fields>
<field>subStyleClass</field>
</fields>
</widget>
<widget name="subItemStyleClass" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Sub item style class</label>
</labels>
<fields>
<field>subItemStyleClass</field>
</fields>
</widget>
<widget name="title" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Title</label>
</labels>
<fields>
<field>title</field>
</fields>
<widgetModes>
<mode value="any">hidden</mode>
<mode value="view_reference">view</mode>
</widgetModes>
</widget>
<widget name="text_localize" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Localize</label>
</labels>
<helpLabels>
<label mode="any">
If set to true, the held value will be translated.
This property cannot be an EL expression, it will only resolve literal
values 'true' or 'false'. Defaults to false. Available since 5.5.
</label>
</helpLabels>
<fields>
<field>localize</field>
</fields>
<widgetModes>
<mode value="edit_demo_preview">hidden</mode>
</widgetModes>
</widget>
<widget name="accesskey" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Access key</label>
</labels>
<fields>
<field>accesskey</field>
</fields>
</widget>
<widget name="alt" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Alt</label>
</labels>
<fields>
<field>alt</field>
</fields>
</widget>
<widget name="dir" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Direction</label>
</labels>
<fields>
<field>dir</field>
</fields>
<selectOptions>
<option itemLabel="" itemValue=""/>
<option itemLabel="Left to right" itemValue="LTR"/>
<option itemLabel="Right to left" itemValue="RTL"/>
</selectOptions>
</widget>
<widget name="placeholder" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Placeholder</label>
</labels>
<helpLabels>
<label mode="any">
String representing a short hint (a word or short
phrase)
intended to aid the user with data entry.
</label>
</helpLabels>
<fields>
<field>placeholder</field>
</fields>
</widget>
<widget name="disabled" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Disabled</label>
</labels>
<fields>
<field>disabled</field>
</fields>
</widget>
<widget name="immediate" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Immediate</label>
</labels>
<fields>
<field>immediate</field>
</fields>
<widgetModes>
<mode value="any">hidden</mode>
<mode value="view_reference">view</mode>
</widgetModes>
</widget>
<widget name="lang" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Lang</label>
</labels>
<fields>
<field>lang</field>
</fields>
</widget>
<widget name="maxlength" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Max length</label>
</labels>
<fields>
<field>maxlength</field>
</fields>
</widget>
<widget name="required" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Required</label>
</labels>
<fields>
<field>required</field>
</fields>
</widget>
<widget name="size" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Size</label>
</labels>
<fields>
<field>size</field>
</fields>
</widget>
<widget name="validator" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Validator</label>
</labels>
<fields>
<field>validator</field>
</fields>
</widget>
<widget name="valueChangeListener" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Value change listener</label>
</labels>
<fields>
<field>valueChangeListener</field>
</fields>
</widget>
<widget name="redisplay" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Redisplay</label>
</labels>
<fields>
<field>redisplay</field>
</fields>
</widget>
<widget name="textarea_cols" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Number of columns</label>
</labels>
<fields>
<field>cols</field>
</fields>
</widget>
<widget name="textarea_rows" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Number of rows</label>
</labels>
<fields>
<field>rows</field>
</fields>
</widget>
<widget name="datetime_pattern" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Pattern</label>
</labels>
<helpLabels>
<label mode="any">
String pattern for the date and time, as described by
the java.text.SimpleDateFormat class, and as used in the standard
DateTimeConverter. Default value is "dd/MM/yyyy HH:mm". Sample value:
"#{nxu:basicDateFormater()}" or "#{nxu:basicDateAndTimeFormater()}".
</label>
</helpLabels>
<fields>
<field>pattern</field>
</fields>
</widget>
<widget name="datetime_timeZone" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Time zone</label>
</labels>
<helpLabels>
<label mode="any">
String timeZone ID. The server time zone is
used if not
set.
</label>
</helpLabels>
<fields>
<field>timeZone</field>
</fields>
</widget>
<widget name="datetime_format" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Format</label>
</labels>
<helpLabels>
<label mode="any">
String format for the date and time, as described by
the java.text.SimpleDateFormat class, and as used in the standard
DateTimeConverter. Default value is "dd/MM/yyyy HH:mm". Sample value:
"#{nxu:basicDateFormater()}" or "#{nxu:basicDateAndTimeFormater()}".
</label>
</helpLabels>
<fields>
<field>format</field>
</fields>
</widget>
<widget name="datetime_locale" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Locale</label>
</labels>
<helpLabels>
<label mode="any">
String representing the locale to use for
the calendar.
Current locale is used if not set.
</label>
</helpLabels>
<fields>
<field>locale</field>
</fields>
<selectOptions>
<option itemLabel="" itemValue=""/>
<option itemLabel="Catalan" itemValue="ca"/>
<option itemLabel="Chinese" itemValue="cn"/>
<option itemLabel="Czech" itemValue="cz"/>
<option itemLabel="Deutsch" itemValue="de"/>
<option itemLabel="English" itemValue="en"/>
<option itemLabel="Spanish" itemValue="es"/>
<option itemLabel="French" itemValue="fr"/>
<option itemLabel="Italiano" itemValue="it"/>
<option itemLabel="Japanese" itemValue="jp"/>
<option itemLabel="Nederlands" itemValue="nl"/>
<option itemLabel="Polish" itemValue="pl"/>
<option itemLabel="Portuguese" itemValue="pt"/>
<option itemLabel="Romanian" itemValue="ro"/>
<option itemLabel="Russian" itemValue="ru"/>
<option itemLabel="svenska" itemValue="sv"/>
</selectOptions>
</widget>
<widget name="datetime_showsTime" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Shows time</label>
</labels>
<helpLabels>
<label mode="any">
Flag indicating that the calendar must show
a time
choice.
Since 5.4.2, this property is ignored and time
is shown
depending on the date format.
</label>
</helpLabels>
<fields>
<field>showsTime</field>
</fields>
</widget>
<widget name="datetime_timeZone" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Time zone</label>
</labels>
<helpLabels>
<label mode="any">
String timeZone ID. The server time zone is used if
not set.
</label>
</helpLabels>
<fields>
<field>timeZone</field>
</fields>
</widget>
<widget name="datetime_triggerImg" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Trigger image</label>
</labels>
<helpLabels>
<label mode="any">
Image path to use for the trigger. Available since
5.4.
</label>
</helpLabels>
<fields>
<field>triggerImg</field>
</fields>
</widget>
<widget name="datetime_triggerLabel" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Trigger label</label>
</labels>
<helpLabels>
<label mode="any">
Label to display on the trigger image. Defaults to
"...".
</label>
</helpLabels>
<fields>
<field>triggerLabel</field>
</fields>
</widget>
<widget name="datetime_triggerStyleClass" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Trigger style class</label>
</labels>
<helpLabels>
<label mode="any">
Style class to set on the trigger button tag, defaults
to 'calendarTrigger'.
</label>
</helpLabels>
<fields>
<field>triggerStyleClass</field>
</fields>
</widget>
<widget name="file_downloadLabel" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Download label</label>
</labels>
<helpLabels>
<label mode="any">
Value binding that will be used as the download link
value, and will attempt to be translated.
</label>
</helpLabels>
<fields>
<field>downloadLabel</field>
</fields>
</widget>
<widget name="file_iconRendered" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Icon rendered</label>
</labels>
<helpLabels>
<label mode="any">
Boolean flag indicating whether or not the file icon
should be rendered. Defaults to true.
</label>
</helpLabels>
<fields>
<field>iconRendered</field>
</fields>
<selectOptions>
<option itemLabel="Yes (default value)" itemValue="true"/>
<option itemLabel="No" itemValue="false"/>
</selectOptions>
</widget>
<widget name="htmltext_disableHtmlInit" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Disable HTML init</label>
</labels>
<helpLabels>
<label mode="any">
If set to true, the default display will be
the text
display
(not html editor). Available since 5.3.1.
</label>
</helpLabels>
<fields>
<field>disableHtmlInit</field>
</fields>
<widgetModes>
<mode value="any">hidden</mode>
<mode value="view_reference">view</mode>
</widgetModes>
</widget>
<widget name="htmltext_width" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Width</label>
</labels>
<helpLabels>
<label mode="any">
The textarea width. Defaults to "640".
</label>
</helpLabels>
<fields>
<field>width</field>
</fields>
</widget>
<widget name="htmltext_height" type="int">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Height</label>
</labels>
<helpLabels>
<label mode="any">
The textarea height. Defaults to "400".
</label>
</helpLabels>
<fields>
<field>height</field>
</fields>
</widget>
<widget name="htmltext_editorSelector" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Editor selector</label>
</labels>
<helpLabels>
<label mode="any">
The class to use to identify text areas to turn into
html editors. Defaults to "mceEditor". See the editor_selector option
in tiny_mce
(http://wiki.moxiecode.com/index.php/TinyMCE:Configuration/editor_selector).
</label>
</helpLabels>
<fields>
<field>editorSelector</field>
</fields>
<widgetModes>
<mode value="any">hidden</mode>
<mode value="view_reference">view</mode>
</widgetModes>
</widget>
<widget name="directoryName" type="selectOneResource">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Vocabulary</label>
</labels>
<fields>
<field>directoryName</field>
</fields>
<widgetModes>
<mode value="edit_demo_preview">hidden</mode>
</widgetModes>
<properties mode="any">
<property name="resourceName">vocabularies</property>
</properties>
<properties widgetMode="any">
<property name="required">true</property>
</properties>
</widget>
<widget name="directoryNameDemoPreview" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Vocabulary</label>
</labels>
<fields>
<field>directoryName</field>
</fields>
<widgetModes>
<mode value="any">hidden</mode>
<mode value="edit_demo_preview">view</mode>
</widgetModes>
<properties widgetMode="any">
<property name="required">true</property>
</properties>
</widget>
<widget name="directory_localize" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Localize</label>
</labels>
<fields>
<field>localize</field>
</fields>
<widgetModes>
<mode value="edit_demo_preview">hidden</mode>
</widgetModes>
</widget>
<widget name="directory_displayIdAndLabel" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Display id and label</label>
</labels>
<fields>
<field>displayIdAndLabel</field>
</fields>
</widget>
<widget name="directory_cssStyle" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Style</label>
</labels>
<fields>
<field>cssStyle</field>
</fields>
</widget>
<widget name="directory_cssStyleClass" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Style class</label>
</labels>
<fields>
<field>cssStyleClass</field>
</fields>
</widget>
<widget name="directory_displayObsoleteEntries" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Display obsolete entries</label>
</labels>
<fields>
<field>displayObsoleteEntries</field>
</fields>
</widget>
<widget name="directory_notDisplayDefaultOption" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Do not display the default option</label>
</labels>
<helpLabels>
<label mode="any">
True if there should not be displayed a "Please select
a value" option
</label>
</helpLabels>
<fields>
<field>notDisplayDefaultOption</field>
</fields>
</widget>
<widget name="directory_ordering" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Sort criterion</label>
</labels>
<fields>
<field>ordering</field>
</fields>
<selectOptions>
<option itemLabel="Label (default)" itemValue="label"/>
<option itemLabel="Ordering" itemValue="ordering"/>
<option itemLabel="Id" itemValue="id"/>
</selectOptions>
</widget>
<widget name="complex_subwidgets_display" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Display</label>
</labels>
<helpLabels>
<label mode="any">
The display attribute controls the rendering of
subwidgets. Available since 5.4.2.
</label>
</helpLabels>
<fields>
<field>display</field>
</fields>
<selectOptions>
<!-- block-like renderings available since 5.6 -->
<option itemLabel="Block (label on the left, default)" itemValue="block_left"/>
<option itemLabel="Block (label on top)" itemValue="block_top"/>
<option itemLabel="Table" itemValue="table"/>
<option itemLabel="In line" itemValue="inline"/>
</selectOptions>
</widget>
<widget name="list_subwidgets_display" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Display</label>
</labels>
<helpLabels>
<label mode="any">
The display attribute controls the rendering of
subwidgets. Available since 5.4.2.
</label>
</helpLabels>
<fields>
<field>display</field>
</fields>
<selectOptions>
<option itemLabel="Block (label on the left, default)" itemValue="block_left"/>
<option itemLabel="Block (label on top)" itemValue="block_top"/>
<option itemLabel="Table" itemValue="table"/>
<option itemLabel="In line" itemValue="inline"/>
</selectOptions>
</widget>
<widget name="subwidgets_hideSubLabels" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Hide subwidgets labels</label>
</labels>
<helpLabels>
<label mode="any">
This attribute controls the rendering of subwidgets
labels. Available since 5.4.2.
</label>
</helpLabels>
<fields>
<field>hideSubLabels</field>
</fields>
</widget>
<widget name="list_diff" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Diff</label>
</labels>
<fields>
<field>diff</field>
</fields>
</widget>
<widget name="list_orderable" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Orderable</label>
</labels>
<helpLabels>
<label mode="any">
This attribute controls the possibility to order the
items. Available since 5.5.
</label>
</helpLabels>
<fields>
<field>orderable</field>
</fields>
</widget>
<widget name="list_hideDeleteButton" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Hide delete button</label>
</labels>
<helpLabels>
<label mode="any">
This attribute controls the possibility to remove the
'delete' button for each list item. Available since 5.6.
</label>
</helpLabels>
<fields>
<field>hideDeleteButton</field>
</fields>
</widget>
<widget name="list_hideAddButton" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Hide add button</label>
</labels>
<helpLabels>
<label mode="any">
This attribute controls the possibility to remove the
'add' button to add an item to the list. Available since 5.6.
</label>
</helpLabels>
<fields>
<field>hideAddButton</field>
</fields>
</widget>
<widget name="list_listTemplateItem" type="text">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">List template item</label>
</labels>
<helpLabels>
<label mode="any">
This attribute enables to control the template for
each item that needs to be added to the list. In most common cases,
this value is deduced from the field definition, using the expression:
#{nxd:propertyDefaultValue(widget.fieldDefinitions[0].propertyName)}.
This needs to be adapted for subwidgets (when handling lists of lists
for instance) or when using this widget on another object that a
DocumentModel property. For instance, for a subwidget, you can use:
#{nxd:propertyDefaultValue('mySchema:listOfLists/stringListItem')}.
Available since 5.6.
</label>
</helpLabels>
<fields>
<field>listTemplateItem</field>
</fields>
</widget>
<widget name="container_subwidgets_display" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Display</label>
</labels>
<helpLabels>
<label mode="any">
The display attribute controls the rendering of
subwidgets.
</label>
</helpLabels>
<fields>
<field>display</field>
</fields>
<selectOptions>
<option itemLabel="Block (label on the left, default)" itemValue="block_left"/>
<option itemLabel="Block (label on top)" itemValue="block_top"/>
<option itemLabel="Table" itemValue="table"/>
<option itemLabel="In line" itemValue="inline"/>
</selectOptions>
</widget>
<widget name="container_subwidgets_hideSubLabels" type="checkbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Hide subwidgets labels</label>
</labels>
<helpLabels>
<label mode="any">
This attribute controls the rendering of subwidgets
labels.
</label>
</helpLabels>
<fields>
<field>hideSubLabels</field>
</fields>
</widget>
<widget name="widgetsDisplay" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Widgets Display</label>
</labels>
<helpLabels>
<label mode="any">
The display attribute controls the rendering of
widgets.
</label>
</helpLabels>
<fields>
<field>widgetsDisplay</field>
</fields>
<selectOptions>
<option itemLabel="Label on the left (default)" itemValue="label_left"/>
<option itemLabel="Label on top" itemValue="label_top"/>
<option itemLabel="No Label" itemValue="no_label"/>
</selectOptions>
</widget>
</extension>